Annotation tools are available in the Review Tab in the Viewer user interface to give your users the ability to create annotations or markups on documents. This requires the pages specified in the settings xml to work correctly:
The settingsenterprise.xml file defines the various interaction points needed for annotations to work.
 Copy Code |
|
|---|---|
| <settings> <conversionFileURL>PCC/convert.ashx</conversionFileURL> <getTotalPagesURL>PCC/gettotalpagecount.ashx</getTotalPagesURL> <getFastPagesURL>PCC/getfastpagecount.ashx</getFastPagesURL> <annotationsFilesURL>PCC/listmarkup.ashx</annotationsFilesURL> <annotationsOpenURL>PCC/openmarkup.ashx</annotationsOpenURL> <annotationsSaveURL>PCC/savemarkup.ashx</annotationsSaveURL> <licenseURL>PCC/License.ashx</licenseURL> </settings> |
|
conversionFileURL
This is the file that does the page conversion and returns the binary.
This should already be set up as a part of Prizm Content Connect Plus installation.
getFastPagesURL
This is the file that calculates the fast page count in the document and returns it.
This should already be set up as a part of Prizm Content Connect Plus installation.
getTotalPagesURL
This is the file that calculates the total pages in the document and returns it.
This should already be set up as a part of Prizm Content Connect Plus installation.
annotationsFilesURL
This is the file on the server that the viewer will call to list existing annotations when a user clicks on “load markups” button.
Arguments Passed (POST):
| documentname | Name of the document specified as a flash variable. |
Return Values:
xml – xml containing list of annotations related to the document.
| Copy Code |
|
|---|---|
| <annotationFiles> <annotation name="documenttest-test 1.xml" label="test 1" id="1"/> <annotation name="documenttest-test 2.xml" label="test 1" id="2"/> <annotation name="documenttest-test 3.xml" label="test 1" id="3"/> </annotationFiles> |
|
| name | Name of the annotation file. |
| label | Label of the annotation file, which is shown to the user and could be the name of file itself. |
| id | Id of the annotation file, which could be anything numeric. |
annotationsOpenURL
This is the file that the viewer calls when a user clicks on an annotation label from the list of annotations received from annotationsFilesURL.
Arguments Passed (POST):
| documentname | Name of the document specified as a flash variable. |
| annotationName | Name of the annotation file as returned by xml from annotationsFilesURL. |
| annotationId | Id of the annotation file as returned by xml from annotationsFilesURL. |
| annotationLabel | Label of the annotation file as returned by xml from annotationsFilesURL. |
Return Values:
Annotation XML file in binary format.
annotationsSaveURL
This is the file on the server that the viewer will call when a user clicks on “Save” button to save annotations.
Arguments Passed:
| documentname | Name of the document specified as a flash variable. |
| annotations | The annotation related data in xml form. POST format. |
| annotationName | The name of the annotation. POST format. |
Return Values:
xml specifying the file was saved successfully.
| Copy Code |
|
|---|---|
| <root> <saveAnnotationResponse saved='1'/> </root> |
|
